Class Whitelist

Summary

Fully Qualified Name: Laminas\Filter\Whitelist
Extends: AbstractFilter

Description

Methods

Name Description Defined By
__construct() Whitelist
__invoke() Invoke filter as a command AbstractFilter
filter() {@inheritDoc} Whitelist
getList() Get the list of items to white-list Whitelist
getOptions() Retrieve options representing object state AbstractFilter
getStrict() Returns whether the in_array() call should be "strict" or not. See in_array docs. Whitelist
hasPcreUnicodeSupport() AbstractFilter
setList() Set the list of items to white-list. Whitelist
setOptions() AbstractFilter
setStrict() Determine whether the in_array() call should be "strict" or not. See in_array docs. Whitelist

Method Details

__construct()

Parameter Name Type Description
$options null|array|\Traversable

Returns:

__invoke()

Invoke filter as a command

Proxies to {@link filter()}

Parameter Name Type Description
$value mixed

Returns: mixed

filter()

{@inheritDoc}

Will return $value if its present in the white-list. If $value is rejected then it will return null.

Parameter Name Type Description
$value

Returns:

getList()

Get the list of items to white-list

Returns: array

getOptions()

Retrieve options representing object state

Returns: array

getStrict()

Returns whether the in_array() call should be "strict" or not. See in_array docs.

Returns: bool

hasPcreUnicodeSupport()

Returns: bool

setList()

Set the list of items to white-list.

Parameter Name Type Description
$list array|\Traversable

Returns:

setOptions()

Parameter Name Type Description
$options array|\Traversable

Returns: self

setStrict()

Determine whether the in_array() call should be "strict" or not. See in_array docs.

Parameter Name Type Description
$strict bool

Returns:

Top